Skip to content

docs(readme): atualiza documentação pra refletir arquitetura atual - #15

Merged
lmoraesdev merged 1 commit into
mainfrom
docs/readme-rewrite
Jul 23, 2026
Merged

docs(readme): atualiza documentação pra refletir arquitetura atual#15
lmoraesdev merged 1 commit into
mainfrom
docs/readme-rewrite

Conversation

@lmoraesdev

Copy link
Copy Markdown
Owner

Summary

O README ainda cobria só o EPIC-001 inicial (criar cobrança). Reescrito por completo pra refletir o estado real do projeto:

  • Resumo focado em concorrência/consistência (idempotência, outbox transacional, optimistic locking) e observabilidade — não é "mais um CRUD de pagamento"
  • Badge de CI confirmado apontando pro workflow e job corretos (ci.yml / Lint + Unit Tests)
  • Stack atualizada com versões reais (Flyway, ArchUnit, Testcontainers, JaCoCo, Micrometer/OTel)
  • Árvore de pacotes hexagonal real (adapter/application/domain/config), com link pro DomainPurityArchTest
  • Padrões implementados, cada um com o "porquê": Transactional Outbox + SKIP LOCKED, Idempotency-Key com replay sob concorrência, Optimistic locking (@Version/Persistable<UUID>), dedup de webhook por event_id, logging 5W1H com correlation_id via MDC
  • Tabela de endpoints (POST /charges, GET /charges/{id}, POST /webhooks/provider) com exemplos conferidos contra os DTOs reais
  • Instruções de execução via docker-compose.yml existente + alternativa sem Docker
  • Testes: unit (Surefire) vs integration (Failsafe + Testcontainers), com exemplos do que cada suite prova
  • Links de Swagger/OpenAPI e observabilidade local

docs/adr não existe no repo (só docs/architecture.md e docs/devops-flow.md), então a seção "Decisões de arquitetura" foi omitida por enquanto, conforme combinado.

Test plan

  • Revisão manual: todos os exemplos de request/response conferem com CreateChargeRequest, CreateChargeResponse, GetChargeResponse, WebhookProviderPayload
  • Só markdown — nenhuma mudança de código

@lmoraesdev
lmoraesdev merged commit e73c387 into main Jul 23, 2026
2 checks passed
@lmoraesdev
lmoraesdev deleted the docs/readme-rewrite branch July 23, 2026 17:28
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant